/*
 * Copyright (C) 2010 Eric Bottard
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.excilys.oss.dao.dynamicfinders;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This annotation can be placed on either a DAO interface or a DAO abstract
 * class (if you don't have an interface). This framework will try to provide an
 * implementation for all methods left abstract (i.e. all of them if placed on
 * an interface).
 * 
 * @author Eric Bottard
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataAccessObject {

	/**
	 * The type of entity this DAO manipulates. Required.
	 */
	Class<?> entityType() default Void.class;

	/**
	 * If using both an interface and an abstract class, put this annotation on
	 * the interface and instruct this framework to use the following 'stub'
	 * class to handle methods that you'd rather implement by hand. The library
	 * will attempt to provide an implementation for all methods that are left
	 * abstract.
	 */
	Class<?> stub() default Object.class;

}
